Functions


Converting an Icon Mask to a Region

IconIDToRgn Converts the icon mask in an icon family to a region.
IconMethodToRgn Converts, to a region, the mask for an icon that IconMethodToRgn obtains with the aid of your icon getter callback function.
IconSuiteToRgn Converts the icon mask in an icon suite to a region.

Creating an Icon Suite

AddIconToSuite Adds an icon to an icon suite.
GetIconSuite Creates an icon suite in memory that contains handles to a specified icon family’s resources.
NewIconSuite Gets a handle to an empty icon suite.

Creating and Managing Universal Procedure Pointers

DisposeIconActionUPP Disposes of the universal procedure pointer (UPP) to your icon action callback function.
DisposeIconGetterUPP Disposes of the universal procedure pointer (UPP) to your icon getter callback function.
InvokeIconActionUPP Calls your icon action callback function.
InvokeIconGetterUPP Calls your icon getter callback function.
NewIconActionUPP Creates a new universal procedure pointer (UPP) to an icon action callback function.
NewIconGetterUPP Creates a new universal procedure pointer (UPP) to an icon getter callback function.

Determining Whether a Point or Rectangle Is Within an Icon

PtInIconID Determines whether a specified point is within an icon.
PtInIconMethod Determines whether a specified point is within an icon obtained with the aid of your icon getter callback function.
PtInIconSuite Determines whether a specified point is within an icon.
RectInIconID Hit-tests a rectangle against the appropriate icon mask from an icon family for a specified destination rectangle and alignment.
RectInIconMethod Hit-tests a rectangle against an icon obtained by your icon getter callback function for a specified destination rectangle and alignment.
RectInIconSuite Hit-tests a rectangle against the appropriate icon mask from an icon suite for a specified destination rectangle and alignment.

Disposing of Icon Suites

DisposeIconSuite Releases the memory occupied by an icon suite.

Disposing of Icons

DisposeCIcon Releases the memory occupied by a color icon structure.

Drawing Icons From Resources

PlotCIcon Draws a color icon of resource type 'cicn' to which you have a handle.
PlotCIconHandle Draws an icon of resource type 'cicn' to which you have a handle.
PlotIcon Draws an icon of resource type 'ICON' to which you have a handle.
PlotIconHandle Draws an icon of resource type 'ICON' or 'ICN#' to which you have a handle.
PlotIconID Draws the icon described by an icon family.
PlotIconMethod Draws an icon obtained with the aid of your icon getter callback function.
PlotSICNHandle Draws a small icon of resource type 'SICN' to which you have a handle.

Drawing Icons From an Icon Suite

PlotIconSuite Draws the icon described by an icon suite using the most appropriate icon in the suite for the current bit depth of the display device and the rectangle in which the icon is to be drawn.

Enabling and Disabling Custom Icons

GetCustomIconsEnabled Determines whether custom icons are enabled or disabled on a specified volume.
SetCustomIconsEnabled Enables or disables custom icons on a specified volume.

Flushing IconRef Data

FlushIconRefs Reclaims memory used by the specified icon if the memory is purgeable.
FlushIconRefsByVolume On a given volume, reclaims memory used by purgeable icons.

Getting Icons From Resources That Don’t Belong to an Icon Family

GetCIcon Gets a handle to a color icon of resource type 'cicn'.
GetIcon Gets a handle to an icon resource of type 'ICON'.

Getting Icons From an Icon Suite

GetIconFromSuite Gets an icon from an icon suite.

Getting Label Information

GetLabel Gets the color and string used for a given label in the Label menu of the Finder and in the Labels control panel.

Getting and Setting the Label for an Icon Suite

GetSuiteLabel Gets the default label setting associated with an icon suite.
SetSuiteLabel Specifies the default label associated with an icon suite.

IconRef Reference Counting

AcquireIconRef Increments the reference count for an IconRef.
GetIconRefOwners Provides the current reference count for an IconRef.
ReleaseIconRef Decrements the reference count for an IconRef.

Modifying IconRef Data

OverrideIconRef Replaces the bitmaps of one IconRef with those of another IconRef.
OverrideIconRefFromResource Replaces the bitmaps in an IconRef with bitmaps from a specified resource file.
RemoveIconRefOverride Restores the original bitmaps of an overridden IconRef.
UpdateIconRef Forces an update of IconRef data.

Obtaining Icon Data

GetIconSizesFromIconRef Provides an IconSelectorValue indicating the sizes and depths of icon data available for an IconRef.
IsIconRefComposite Reports whether a specified IconRef has been composited.
IsIconRefMaskEmpty Reports whether a specified mask is empty.
IsValidIconRef Reports whether a specified IconRef is valid.

Obtaining IconRef Values

GetIconRef Provides an IconRef for an icon in the desktop database or for a registered icon.
GetIconRefFromFile Provides an IconRef for a file, folder or volume.
GetIconRefFromFolder Provides an IconRef for a folder with no custom icon.

Performing Operations on Icons in an Icon Suite

ForEachIconDo Performs an action on one or more icons in an icon suite.

Reading, Copying, and Converting Icon Data

GetIconFamilyData Obtains a copy of the data for a specified icon family.
IconFamilyToIconSuite Provides iconSuite data for a given icon family.
IconRefToIconFamily Provides icon family data for a given IconRef.
IconSuiteToIconFamily Provides IconFamily data for a specified IconSuite.
ReadIconFile Copies data from a given file into an icon family.
SetIconFamilyData Provides new data for a specified icon family.
WriteIconFile Copies data from a given icon family into a file.

Registering and Unregistering IconRef Values

RegisterIconRefFromIconFamily Adds an iconFamily-derived IconRef to the Icon Services registry.
RegisterIconRefFromIconFile Adds a file-derived IconRef to the Icon Services registry.
RegisterIconRefFromResource Adds a resource-derived IconRef to the Icon Services registry.
UnregisterIconRef Removes the specified icon data from the icon registry.

Using IconRef Data

CompositeIconRef Superimposes one IconRef onto another.
GetIconRefVariant Specifies a transformation for a given IconRef.
IconRefToRgn Converts an IconRef-derived icon into a QuickDraw region.
PlotIconRef Draws an icon using appropriate size and depth data from an IconRef.
PtInIconRef Tests whether a specified point falls within an icon’s mask.
RectInIconRef Tests whether a specified rectangle falls within an icon’s mask.

Working With Icon Caches

GetIconCacheData Gets the data associated with an icon cache.
GetIconCacheProc Gets the icon getter function associated with an icon cache.
LoadIconCache Loads into an icon cache a handle to the appropriate icon data for a specified destination rectangle and the current bit depth, for drawing later with a specified alignment and transform.
MakeIconCache Gets a handle to an empty icon cache.
SetIconCacheData Sets the data associated with an icon cache.
SetIconCacheProc Sets the icon getter callback function associated with an icon cache.

Miscellaneous

CallIconActionProc
CallIconGetterProc
GetBaseIconRefFromFile
IconServicesInit
IconServicesTerminate
NewIconActionProc
NewIconGetterProc
SetCustomIconFamily

© 2000 Apple Computer, Inc. — (Last Updated 4/18/2000)